mediawiki.js: Fix docucumentation breakage
authorTimo Tijhof <krinklemail@gmail.com>
Tue, 29 Oct 2013 00:30:29 +0000 (01:30 +0100)
committerTimo Tijhof <krinklemail@gmail.com>
Tue, 29 Oct 2013 00:40:30 +0000 (01:40 +0100)
* Unformatted code and unclosed <media> tag.
  Depending on which versions of other libs are installed, this
  error can occur. Current version (v4.x) in production doesn't
  require this yet. But local environment with the same version
  does. And the next version of jsduck (v5.x) will consistently
  work this way for compliance with Markdown.

* Simplified @link while at it to use the cleaner implied link
  instead like we do elsewhere ({@link} should rarely be
  used directly).

* Add /** @class */ because half the file was no longer indexed
  as part of mw (instead became part of mw.Message after 4f23099)

* Index the private mw#log as log_ instead because it clashes
  with the public mw#log. This should've clashed in 4f23099, but
  didn't because the other one was seen as part of mw.Message
  by the test.

Change-Id: Ic5b8c5c743ecdb1509652c3655d83e501f6fa9ee

resources/mediawiki/mediawiki.js

index acda5d6..f4ea93f 100644 (file)
@@ -21,6 +21,7 @@ var mw = ( function ( $, undefined ) {
         * fine. No need for optimization here, which would only result in losing logs.
         *
         * @private
+        * @method log_
         * @param {string} msg text for the log entry.
         * @param {Error} [e]
         */
@@ -318,6 +319,9 @@ var mw = ( function ( $, undefined ) {
                }
        };
 
+       /**
+        * @class mw
+        */
        return {
                /* Public Members */
 
@@ -1460,16 +1464,19 @@ var mw = ( function ( $, undefined ) {
                                 * @param {Function|Array} script Function with module code or Array of URLs to
                                 *  be used as the src attribute of a new `<script>` tag.
                                 * @param {Object} style Should follow one of the following patterns:
+                                *
                                 *     { "css": [css, ..] }
                                 *     { "url": { <media>: [url, ..] } }
+                                *
                                 * And for backwards compatibility (needs to be supported forever due to caching):
+                                *
                                 *     { <media>: css }
                                 *     { <media>: [url, ..] }
                                 *
                                 * The reason css strings are not concatenated anymore is bug 31676. We now check
                                 * whether it's safe to extend the stylesheet (see #canExpandStylesheetWith).
                                 *
-                                * @param {Object} msgs List of key/value pairs to be added to {@link mw#messages}.
+                                * @param {Object} msgs List of key/value pairs to be added to mw#messages.
                                 */
                                implement: function ( module, script, style, msgs ) {
                                        // Validate input